/*
 *    Copyright (c) 2014 Xiang Xu <xuxiang@mail.bnu.edu.cn>
 *
 *    Permission is hereby granted, free of charge, to any person
 *    obtaining a copy of this software and associated documentation
 *    files (the "Software"), to deal in the Software without
 *    restriction, including without limitation the rights to use,
 *    copy, modify, merge, publish, distribute, sublicense, and/or sell
 *    copies of the Software, and to permit persons to whom the
 *    Software is furnished to do so, subject to the following
 *    conditions:
 *
 *    The above copyright notice and this permission notice shall be
 *    included in all copies or substantial portions of the Software.
 *
 *    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 *    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 *    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 *    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 *    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *    OTHER DEALINGS IN THE SOFTWARE.
 */


#ifndef STATUS_H
#define STATUS_H
#include <iostream>
#include <string>

class Status
{
public:
    Status() {}
    Status(const std::string& description);
    virtual ~Status();

    // static method to produce common Status
    inline static Status Success()
    {
        return Status("success");
    }
    inline static Status OpenFileFail()
    {
        return Status("open file fail");
    }
    inline static Status FatalError()
    {
        return Status("fatal error");
    }

    inline bool IsOk()
    {
        return (description_ == "success");
    }
    inline std::string GetDescription()
    {
        return description_;
    }

    // overwrite operator
    friend inline std::ostream& operator<< (std::ostream& os, Status& status)
    {
        os << status.description_ << std::endl;
        return os;
    }

private:
    std::string description_;
};

#endif // STATUS_H
